Conversation
GITHUB_TOKEN should be generated automatically when the workflow is executed to enable the workflow to upload artifacts automatically.
Author
|
GitHub Pages is a bit interesting. So you can generate documentation and upload it to GitHub Pages, but that is not enough to read the documentation. To read the documentation you have to clone the Alternatively we can set something up on |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adding a workflow to generate source code documentation using Doxygen (Sphinx was the other option but that mixes a bunch of configuration files with the source code, which is messy). As far as I am able to test this set up it successfully generates the documentation in HTML format. However, at present the contents are limited by the fact that the code does not contain any doc-strings to generate documentation from.
In the current set up the documentation is automatically pushed to a GitHub Pages branch on the repo (gh-pages). On the first attempt there are likely going to be some issues as a few additional configuration steps on the gh-pages branch are required (https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-first-deployment-with-github_token).